<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.module.MultiSectionFactory</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        <a href="pybindgen.module-module.html">Module&nbsp;module</a> ::
        Class&nbsp;MultiSectionFactory
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.module.MultiSectionFactory-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MultiSectionFactory</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_pybindge_63" name="uml_class_diagram_for_pybindge_63">
<area shape="rect" href="pybindgen.module.MultiSectionFactory-class.html#get_section_code_sink" title="Create and/or return a code sink for a given section." alt="" coords="17,36,273,55"/>
<area shape="rect" href="pybindgen.module.MultiSectionFactory-class.html#get_main_code_sink" title="Create and/or return a code sink for the main file." alt="" coords="17,55,273,73"/>
<area shape="rect" href="pybindgen.module.MultiSectionFactory-class.html#get_common_header_code_sink" title="Create and/or return a code sink for the common header." alt="" coords="17,73,273,92"/>
<area shape="rect" href="pybindgen.module.MultiSectionFactory-class.html#get_common_header_include" title="Return the argument for an #include directive to include the common header." alt="" coords="17,92,273,111"/>
<area shape="rect" href="pybindgen.module.MultiSectionFactory-class.html" title="Abstract base class for objects providing support for multi&#45;section code generation, i.e., splitting the generated C/C++ code into multiple files." alt="" coords="16,11,275,112"/>
</map>
  <img src="uml_class_diagram_for_pybindge_63.gif" alt='' usemap="#uml_class_diagram_for_pybindge_63" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Abstract base class for objects providing support for multi-section 
  code generation, i.e., splitting the generated C/C++ code into multiple 
  files.  The generated code will generally have the following 
  structure:</p>
  <ol start="1">
    <li>
      For each section there is one source file specific to that section;
    </li>
    <li>
      There is a <i>main</i> source file, e.g. <code>foomodule.cc</code>.  
      Code that does not belong to any section will be included in this 
      main file;
    </li>
    <li>
      Finally, there is a common header file, (e.g. foomodule.h), which is 
      included by the main file and section files alike. Typically this 
      header file contains function prototypes and type definitions.
    </li>
  </ol>

<hr />
<div class="fields">      <p><strong>See Also:</strong>
        <a href="pybindgen.module.Module-class.html#generate" 
        class="link">Module.generate</a>
      </p>
</div><!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.module.MultiSectionFactory-class.html#get_section_code_sink" class="summary-sig-name">get_section_code_sink</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">section_name</span>)</span><br />
      Create and/or return a code sink for a given section.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_section_code_sink">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_main_code_sink"></a><span class="summary-sig-name">get_main_code_sink</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Create and/or return a code sink for the main file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_main_code_sink">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_common_header_code_sink"></a><span class="summary-sig-name">get_common_header_code_sink</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Create and/or return a code sink for the common header.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_common_header_code_sink">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.module.MultiSectionFactory-class.html#get_common_header_include" class="summary-sig-name">get_common_header_include</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Return the argument for an #include directive to include the common 
      header.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_common_header_include">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="get_section_code_sink"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_section_code_sink</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">section_name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_section_code_sink">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Create and/or return a code sink for a given section.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>section_name</code></strong> - name of the section</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>a <a href="pybindgen.typehandlers.codesink.CodeSink-class.html" 
          class="link">CodeSink</a> object that will receive generated code
          belonging to the section <code>section_name</code></dd>
  </dl>
</td></tr></table>
</div>
<a name="get_common_header_include"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_common_header_include</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.module-pysrc.html#MultiSectionFactory.get_common_header_include">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return the argument for an #include directive to include the common 
  header.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>a string with the header name, including surrounding &quot;&quot;
          or &lt;&gt;.  For example, '&quot;foomodule.h&quot;'.</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:25 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
